Vcenter VM CreateSpec
Document-based creation spec.
{
"guest_os": "string",
"name": "string",
"placement": {
"folder": "string",
"resource_pool": "string",
"host": "string",
"cluster": "string",
"datastore": "string"
},
"hardware_version": "string",
"boot": {
"type": "string",
"efi_legacy_boot": false,
"network_protocol": "string",
"delay": 0,
"retry": false,
"retry_delay": 0,
"enter_setup_mode": false
},
"boot_devices": [
{
"type": "string"
}
],
"cpu": {
"count": 0,
"cores_per_socket": 0,
"hot_add_enabled": false,
"hot_remove_enabled": false
},
"memory": {
"size_mib": 0,
"hot_add_enabled": false
},
"disks": [
{
"type": "string",
"ide": {
"primary": false,
"master": false
},
"scsi": {
"bus": 0,
"unit": 0
},
"sata": {
"bus": 0,
"unit": 0
},
"nvme": {
"bus": 0,
"unit": 0
},
"backing": {
"type": "string",
"vmdk_file": "string"
},
"new_vmdk": {
"name": "string",
"capacity": 0,
"storage_policy": {
"policy": "string"
}
}
}
],
"nics": [
{
"type": "string",
"upt_compatibility_enabled": false,
"upt_v2_compatibility_enabled": false,
"mac_type": "string",
"mac_address": "string",
"pci_slot_number": 0,
"wake_on_lan_enabled": false,
"backing": {
"type": "string",
"network": "string",
"distributed_port": "string"
},
"start_connected": false,
"allow_guest_control": false
}
],
"cdroms": [
{
"type": "string",
"ide": {
"primary": false,
"master": false
},
"sata": {
"bus": 0,
"unit": 0
},
"backing": {
"type": "string",
"iso_file": "string",
"host_device": "string",
"device_access_type": "string"
},
"start_connected": false,
"allow_guest_control": false
}
],
"floppies": [
{
"backing": {
"type": "string",
"image_file": "string",
"host_device": "string"
},
"start_connected": false,
"allow_guest_control": false
}
],
"parallel_ports": [
{
"backing": {
"type": "string",
"file": "string",
"host_device": "string"
},
"start_connected": false,
"allow_guest_control": false
}
],
"serial_ports": [
{
"yield_on_poll": false,
"backing": {
"type": "string",
"file": "string",
"host_device": "string",
"pipe": "string",
"no_rx_loss": false,
"network_location": "string",
"proxy": "string"
},
"start_connected": false,
"allow_guest_control": false
}
],
"sata_adapters": [
{
"type": "string",
"bus": 0,
"pci_slot_number": 0
}
],
"scsi_adapters": [
{
"type": "string",
"bus": 0,
"pci_slot_number": 0,
"sharing": "string"
}
],
"nvme_adapters": [
{
"bus": 0,
"pci_slot_number": 0
}
],
"storage_policy": {
"policy": "string"
}
}Guest OS.
For more information see: Vcenter Vm GuestOS.
Virtual machine name.
If missing or null, a default name will be generated by the server.
Virtual machine placement information.
This property is currently required. In the future, if this property is missing or null, the system will attempt to choose suitable resources on which to place the virtual machine.
Virtual hardware version.
For more information see: Vcenter Vm Hardware Version.
If missing or null, defaults to the most recent version supported by the server.
Boot configuration.
If missing or null, guest-specific default values will be used.
Boot device configuration.
If missing or null, a server-specific boot sequence will be used.
CPU configuration.
If missing or null, guest-specific default values will be used.
Memory configuration.
If missing or null, guest-specific default values will be used.
List of disks.
If missing or null, a single blank virtual disk of a guest-specific size will be created on the same storage as the virtual machine configuration, and will use a guest-specific host bus adapter type. If the guest-specific size is 0, no virtual disk will be created.
List of Ethernet adapters.
If missing or null, no Ethernet adapters will be created.
List of CD-ROMs.
If missing or null, no CD-ROM devices will be created.
List of floppy drives.
If missing or null, no floppy drives will be created.
List of parallel ports.
If missing or null, no parallel ports will be created.
List of serial ports.
If missing or null, no serial ports will be created.
List of SATA adapters.
If missing or null, any adapters necessary to connect the virtual machine's storage devices will be created; this includes any devices that explicitly specify a SATA host bus adapter, as well as any devices that do not specify a host bus adapter if the guest's preferred adapter type is SATA.
List of SCSI adapters.
If missing or null, any adapters necessary to connect the virtual machine's storage devices will be created; this includes any devices that explicitly specify a SCSI host bus adapter, as well as any devices that do not specify a host bus adapter if the guest's preferred adapter type is SCSI. The type of the SCSI adapter will be a guest-specific default type.
List of NVMe adapters.
This property was added in vSphere API 7.0.0.1.
If missing or null, any adapters necessary to connect the virtual machine's storage devices will be created; this includes any devices that explicitly specify a NVMe host bus adapter, as well as any devices that do not specify a host bus adapter if the guest's preferred adapter type is NVMe.
The Vcenter VM StoragePolicySpec schema contains information about the storage policy that is to be associated with the virtual machine home (which contains the configuration and log files).
This property was added in vSphere API 6.7.
If missing or null the datastore default storage policy (if applicable) is applied. Currently a default storage policy is only supported by object datastores : VVol and vSAN. For non-object datastores, if missing or null then no storage policy would be associated with the virtual machine home.